Represents an incentive program, such as a prize draw or a set of gift vouchers to be allocated
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| website | Website | ||
| id | long | ||
| pointsType | PointsType | Is this reward part of a points system? If null then its not. Otherwise indicates whether points should accumulate to the profile (ie the user) or to their organisation. If to their organisation, the the pointsOrgType | |
| template | String | If set is the path to a template that should be used to render the reward | |
| pointsOrgType | OrgType | If the points type is POINTS_ORG, then this property should specify what type of organisation to award points to. This is important, because a user can be associated with many organisations | |
| title | String | User entered title of the reward | |
| name | String | The auto-assigned identifier for the reward. It should be derived from the title, but is immutable from a user's perspective so that it can map to a fixed directory in the rewards repository | |
| notes | String | ||
| onePerRecipient | Boolean | Indicates if this reward maybe given to a recipient (ie a user, or their org) multiple times or only once. | |
| status | String | Status code can be one of: a = active e = expired (ie has finished running) f = fulfilled (ie the administrator has processed the draw or competition) null = draft, disabled | |
| startDate | Date | ||
| endDate | Date | ||
| expiryDate | Date | ||
| deletedDate | Date | ||
| deletedBy | Profile | ||
| validForDays | Integer | ||
| fulfiledDate | Date | Date the reward was processed, ie when it has been exported and gift vouchers allocated, or prize draw entries collected. | |
| completedModulesOrgType | OrgType | If using orgCompletedModules, then this field specifies the type of organisation which should be considered for the current user. Ie for the current user, for each membership, if the membership is to an organisation of this type then check if it has users who have completed the module | |
| orgCompletedModules | String | A CSV string of module paths (including website) which identify modules which must be completed by the user's organisation (ie any user within this user's org) for this reward to be activated Eg mywebsite:/p1/c1/m1,mywebsite2:/p2/c2/m2 | |
| userCompletedModules | String | A CSV string of module paths (including website) which identify modules which must be completed by the user for this reward to be activated Eg mywebsite:/p1/c1/m1,mywebsite2:/p2/c2/m2 | |
| groupRewards | List | A GroupReward makes a link between a reward and a group, which then permits members of that group to receive the reward | |
| subTitle | String | ||
| image | ItemImage | ||
| winners | String | ||
| extraFields | NvSet | ||
| autoReconcile | Boolean | Applicable to poins buckets only. If true, debits will be connected to credits | |
| requireApproval | Boolean | ||
| externalUrl | String |
Hide comments
